HELP - CppDocCommentStyle
HelpExample CodeHowToDocumentCppDocCommentStyle
Description Source Call Graph
HowToDocument::CppDocCommentStyle ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Document using multiple lines preceeded with ///.
 
Syntax / parameters
void CppDocCommentStyle ()

Description
Document using multiple lines preceeded with ///.
To document this function. The C++ style single line comments (use: /// ) are joined to one single block. Works everywhere not just for functions.

This is how it looks in the source:
/// Document using multiple lines preceeded with ///.
/// To document this function. The C++ style single line comments (use: #///# ) 
/// are joined to one single block. Works everywhere not just for functions.

 
Source
The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h